/*
 * Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.runtime;

import java.nio.file.Path;
import java.util.function.Function;

import org.graalvm.options.OptionDescriptors;
import org.graalvm.options.OptionValues;

import com.oracle.truffle.api.TruffleLogger;

public interface EngineCacheSupport extends OptimizedRuntimeServiceProvider {

    void onEngineCreated(EngineData e);

    void onEnginePatch(EngineData e);

    boolean onEngineClosing(EngineData e);

    @SuppressWarnings("unused")
    default boolean onStoreCache(EngineData e, Path path, long cancelledWord) {
        throw new UnsupportedOperationException("Engine persist ist not yet supported on this JDK. Please update to resolve this problem.");
    }

    void onEngineClosed(EngineData e);

    boolean isStoreEnabled(OptionValues options);

    Object tryLoadingCachedEngine(OptionValues options, Function<String, TruffleLogger> loggerFactory);

    final class Disabled implements EngineCacheSupport {

        @Override
        public void onEngineCreated(EngineData e) {
        }

        @Override
        public void onEnginePatch(EngineData e) {
        }

        @Override
        public Object tryLoadingCachedEngine(OptionValues options, Function<String, TruffleLogger> loggerFactory) {
            return null;
        }

        @Override
        public boolean onEngineClosing(EngineData e) {
            return false;
        }

        @Override
        public boolean isStoreEnabled(OptionValues options) {
            return false;
        }

        @Override
        public void onEngineClosed(EngineData e) {
        }

        @Override
        public int getPriority() {
            // only last resort
            return Integer.MIN_VALUE;
        }

        @Override
        public OptionDescriptors getEngineOptions() {
            return OptionDescriptors.EMPTY;
        }

    }

    static EngineCacheSupport get() {
        return OptimizedTruffleRuntime.getRuntime().getEngineCacheSupport();
    }

}
